

#ifndef __I_READ_FILE_H_INCLUDED__
#define __I_READ_FILE_H_INCLUDED__

#include "IUnknown.h"

namespace irr
{
    namespace io
    {

        //! Interface providing read acess to a file.
        class IReadFile : public IUnknown
        {
        public:

            virtual ~IReadFile() {};

            //! Reads an amount of bytes from the file.
            //! \param buffer: Pointer to buffer where to read bytes will be written to.
            //! \param sizeToRead: Amount of bytes to read from the file.
            //! \return Returns how much bytes were read.
            virtual s32 read(void* buffer, s32 sizeToRead) = 0;

            //! Changes position in file, returns true if successful.
            //! \param finalPos: Destination position in the file.
            //! \param relativeMovement: If set to true, the position in the file is
            //! changed relative to current position. Otherwise the position is changed 
            //! from begin of file.		
            //! \return Returns true if successful, otherwise false.
            virtual bool seek(s32 finalPos, bool relativeMovement = false) = 0;

            //! Returns size of file.
            //! \return Returns the size of the file in bytes.
            virtual s32 getSize() = 0;

            //! Returns the current position in the file.
            //! \return Returns the current position in the file in bytes.
            virtual s32 getPos() = 0;

            //! Returns name of file.
            //! \return Returns the file name as zero terminated character string.
            virtual const c8* getFileName() = 0;
        };

        //! Internal function, please do not use.
        IReadFile* createReadFile(const c8* fileName);
        //! Internal function, please do not use.
        IReadFile* createLimitReadFile(const c8* fileName, IReadFile* alreadyOpenedFile, s32 areaSize);
        //! Internal function, please do not use.
        IReadFile* createMemoryReadFile(void* memory, s32 size, const c8* fileName, bool deleteMemoryWhenDropped);

    } // end namespace irr
} // end namespace io

#endif

